Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added autoSortReleases to Changelog and parser #51

Merged
merged 11 commits into from
Feb 22, 2025

Conversation

wilkmaciej
Copy link
Contributor

@wilkmaciej wilkmaciej commented Feb 14, 2025

I added option to disable automatically sorting releases in parser and changelog.
This would allow to preserve original order of releases in changelog file and allow to be used in CI/CD pipeline to check if user properly ordered changelog versions.
I didn't add this functionality to bin.ts. If you think it should be added I will gladly add it there.
I also didn't found any guidelines what and when should be added to main changelog file of this library so i didn't add anything for now.
There is also no information how library should be formatted. I think it should be foramatted using deno fmt but after running that command there appers to be files not formatted with it. Whatever the case is I can add github actions to run formatter when creating a PR.

Copy link
Owner

@oscarotero oscarotero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!
I like the feature but not convinced about the implementation, so I left a comment with another approach :). Let me know what you think.

Regarding formatting, deno fmt should be used. In my computer it does some changes, so make sure you have an up to date Deno version.

Changes in CHANGELOG.md are added in the example.ts file (but I just realized that I forgot to update and run the script in the last release!). I think you can edit the 2.6.0 version in example.ts (that never was released) and add your changes there.

Copy link
Owner

@oscarotero oscarotero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks good!
I just left a comment regarding the option name in the CLI.

@oscarotero oscarotero merged commit 61938a6 into oscarotero:master Feb 22, 2025
@oscarotero
Copy link
Owner

thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants